/**
 * Copyright 2016 Twitter. All rights reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */


package com.twitter.graphjet.algorithms.intersection;

/**
 * Abstracts out the update weights for related tweets.
 */
public abstract class RelatedTweetUpdateNormalization {

  /**
   * Provides an interface for clients to compute related tweet update weights
   *
   * @param leftNodeDegree is the degree of the leftNode
   * @return a transformation of the leftNode degree
   */
  public abstract double computeLeftNeighborContribution(int leftNodeDegree);

  /**
   * Provides an interface for clients to compute related tweet score normalization
   *
   * @param cooccurrence is the computed cooccurrence
   * @param similarNodeDegree is the degree of the candidate tweet
   * @param nodeDegree is the degree of the query tweet
   * @return a transformation of the leftNode degree
   */
  public abstract double computeScoreNormalization(double cooccurrence, int similarNodeDegree,
      int nodeDegree);
}
